.\" Copyright (C) 2010-2013 Shang-Rong Cai. All rights reserved.
.\" 
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\" 
.\" $ BASE: bscmpi.3    Rev. 1.2.0    2013-03-06T00:26+08:00 $
.TH BSCMPI 3 2012-11-13 "BASE 1.2" "Base Architecture Source Equipment"
.SH NAME
\fBbscmpi\fP - Macro about using MPI library
.SH SYNOPSIS
\fB#include <bscmpi.h>\fP

.SH DESCRIPTION
This header file defines the self defined macro or some new feature appeared in 
MPI standard 2.2 but not in the elder MPI library.  
.TP
\fBBASE_MPI_SIDX_T\fP
Self defined MPI_Datetype for signed index type (\fIsidx_t\fP).
.TP
\fBBASE_MPI_UIDX_T\fP
Self defined MPI_Datetype for signed index type (\fIuidx_t\fP).
.TP
\fBBASE_MPI_CELL_T\fP
Self defined MPI_Datatype for cell type (\fIcell_t\fP).
.TP
\fBBASE_MPI_FACE_T\fP
Self defined MPI_Datatype for face type (\fIface_t\fP).
.TP
\fBBASE_MPI_SIZE_T\fP
Self defined MPI_Datatype for \fIsize_t\fP.

.LP
Some integer type of MPI_Datatype appeared after MPI standard 2.2.  When the 
version of MPI library is elder than MPI standard 2.2, then users should define 
the building environment variable \fBLEGACY_MPI=YES\fP while building program 
depending on this toolkit.
.TP
\fBMPI_INT8_T\fP
8 bits signed integer type (\fIint8_t\fP).
.TP
\fBMPI_INT16_T\fP
16 bits signed integer type (\fIint16_t\fP).
.TP
\fBMPI_INT32_T\fP
32 bits signed integer type (\fIint32_t\fP).
.TP
\fBMPI_INT64_T\fP
64 bits signed integer type (\fIint64_t\fP).
.TP
\fBMPI_UINT8_T\fP
8 bits unsigned integer type (\fIuint8_t\fP).
.TP
\fBMPI_UINT16_T\fP
16 bits unsigned integer type (\fIuint16_t\fP).
.TP
\fBMPI_UINT32_T\fP
32 bits unsigned integer type (\fIuint32_t\fP).
.TP
\fBMPI_UINT64_T\fP
64 bits unsigned integer type (\fIuint64_t\fP).

.SH SEE ALSO
stdint(7), MPI(3)

